Content Library SubscriptionInfo
The Content Library SubscriptionInfo schema defines the subscription behavior for a subscribed library.
{
"authentication_method": "string",
"automatic_sync_enabled": false,
"on_demand": false,
"password": "string",
"ssl_thumbprint": "string",
"subscription_url": "string",
"user_name": "string",
"source_info": {
"source_library": "string",
"subscription": "string"
},
"ssl_certificate": "string"
}Indicate how the subscribed library should authenticate (AuthenticationMethod) with the published library endpoint.
For more information see: Content Library SubscriptionInfo AuthenticationMethod.
This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.
Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global Content ConfigurationModel.automatic_sync_enabled option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to POST /content/subscribed-library/{libraryId}?action=sync or POST /content/library/subscribed-item/{libraryItemId}?action=sync. In other words, manual synchronization is still available even when automatic synchronization is disabled.
This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.
Indicates whether a library item's content will be synchronized only on demand.
If this is set to true, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.
Items without synchronized content can be forcefully synchronized in advance using the POST /content/library/subscribed-item/{libraryItemId}?action=sync call with forceSyncContent set to true. Once content has been synchronized, the content can removed with the POST /content/library/subscribed-item/{libraryItemId}?action=evict call.
If this value is set to false, all content will be synchronized in advance.
This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.
The password to use when authenticating.
The password must be set when using a password-based authentication method; empty strings are not allowed.
This property is optional for the create operation. It will not be present in the response of the get or list operations. It is optional for the update operation.
An optional SHA-1 hash of the SSL certificate for the remote endpoint.
If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is missing or null. The specified sslThumbprint will not be checked for SSL certificate validation if {SubscriptionInfo#sslCertificate} is also set.
This property is optional for the create operation. It will not be present in the response of the get or list operations. It is optional for the update operation.
The URL of the endpoint where the metadata for the remotely published library is being served.
This URL can be the Content Library PublishInfo.publish_url of the published library (for example, https://server/path/lib.json).
If the source content comes from a published library with Content Library PublishInfo.persist_json_enabled, the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:
vSphere 6.5
- ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
- nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
- nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
- smb://server/path/mylibrary/lib.json (for SMB server)
vSphere 6.0
- file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
- file:///path/mylibrary/lib.json (for local file system)
When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the Content Library StorageBacking.storage_uri of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.
This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.
The username to use when authenticating.
The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.
This property is optional for the create operation. It is optional in the response of the get or list operations. It is optional for the update operation.
Information about the source published library. This property will be set for a subscribed library which is associated with a subscription of the published library.
This property was added in vSphere API 6.7.2.
This property is optional for the create operation. It is optional in the response of the get or list operations. It is optional for the update operation.
An optional SSL certificate for the remote endpoint.
If this value is defined the SSL certificate will be verified by comparing it to this sslCertificate. When specified, the standard certificate chain validation behavior is not used. If this value is missing or null {SubscriptionInfo#sslThumbprint} will be used for SSL certificate validation. The certificate chain is validated normally if this value and {SubscriptionInfo#sslThumbprint} is missing or null.
This property was added in vSphere API 9.0.0.0.
This property is optional for the create operation. It will not be present in the response of the get or list operations. It is optional for the update operation.